Fixes #508 Document values in a collection with a default value is ap… #509
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…efault value is appended to the default value
DiscoPYF
reviewed
Aug 30, 2025
There was a problem hiding this comment.
Thank you @JLedel for another great contribution!
Consumers may be relying on the existing behavior, so it would be good to expose a serialization option to control the behavior (ApiClientSerializationOptions).
What about keeping the default as "auto" but making it configurable?
var options = new ApiClientSerializationOptions()
{
ReplaceObjects = true // Default is false
};
var doc = await docApi.GetDocumentAsync<TestModel>("TestModel", "0123456789", serializationOptions: options);We would need to add a new optional parameter of type ApiClientSerializationOptions for most "GET" methods, as they currently don't expose serialization options.
@rossmills99 What do you think?
Could you also add a unit test to validate and document the behavior? e.g. DeserializeFromStream_ShouldIgnoreDefaultValues_WhenObjectNotReused.
It also affects properties with a class type.
Here is something I put together to test:
public class TestModel
{
/*...*/
public List<string> ListWithDefaultValue { get; set; } = ["Value1"];
public InnerTestModel ObjectWithDefaultValue = new()
{
InnerTestModel_PropertyToCheckIfCamelCase = "defaultValue"
};
}// JsonNetApiClientSerializationTest
[Fact]
public void DeserializeFromStream_ShouldNotKeepDefaultValues()
{
byte[] jsonBytes = Encoding.UTF8.GetBytes(
"{\"MyStringDict\": { \"key2\": \"value2\" }, \"ListProperty\": [\"Value2\"], \"ObjectWithDefaultValue\": { \"InnerTestModel_NullProperty\": \"Something\" }}");
var stream = new MemoryStream(jsonBytes);
var serialization = new JsonNetApiClientSerialization();
TestModel model = serialization.DeserializeFromStream<TestModel>(stream);
Assert.Equal("Something", model.ObjectWithDefaultValue.InnerTestModel_NullProperty);
Assert.Null(model.ObjectWithDefaultValue.InnerTestModel_PropertyToCheckIfCamelCase);
Assert.Single(model.ListWithDefaultValue);
Assert.Equal("Value2", model.ListWithDefaultValue[0]);
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…pended to the default value